Class ELogException

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ELogNotFound, ELogPluginNotFound

public class ELogException extends EBaseException
This class implements a Log exception. LogExceptions should be caught by LogSubsystem managers.

Version:
$Revision$, $Date$
See Also:
  • Constructor Details

    • ELogException

      public ELogException(String msgFormat)
      Constructs a log exception.

      Parameters:
      msgFormat - Exception details.
    • ELogException

      public ELogException(String msgFormat, String param)
      Constructs a log exception with a parameter. For example,
       new ELogException("failed to load {0}", fileName);
       

      Parameters:
      msgFormat - Exception details in message string format.
      param - Message string parameter.
    • ELogException

      public ELogException(String msgFormat, Exception param)
      Constructs a log exception. It can be used to carry a system exception that may contain information about the context. For example,
                      try {
                      ...
                      } catch (IOExeption e) {
                              throw new ELogException("Encountered System Error {0}", e);
            }
       

      Parameters:
      msgFormat - Exception details in message string format.
      param - System exception.
    • ELogException

      public ELogException(String msgFormat, Object[] params)
      Constructs a log exception with a list of parameters that will be substituted into the message format.

      Parameters:
      msgFormat - Exception details in message string format.
      params - List of message format parameters.
  • Method Details

    • getParameters

      public Object[] getParameters()
      Returns a list of parameters.

      Overrides:
      getParameters in class EBaseException
      Returns:
      list of message format parameters.
    • toString

      public String toString()
      Returns localized exception string. This method should only be called if a localized string is necessary.

      Overrides:
      toString in class EBaseException
      Returns:
      Details message.
    • toString

      public String toString(Locale locale)
      Returns the string based on the given locale.

      Overrides:
      toString in class EBaseException
      Parameters:
      locale - Locale.
      Returns:
      Details message.
    • getBundleName

      protected String getBundleName()
      Retrieves resource bundle name. Subclasses should override this as necessary
      Overrides:
      getBundleName in class EBaseException
      Returns:
      String containing name of resource bundle.